home *** CD-ROM | disk | FTP | other *** search
/ Acorn User: China / Acorn User China CD-ROM (UK) (Disc A) / Acorn User China CD-ROM (UK) (Disc A).bin / HENSA / DATABASE / INDEXER.ARC / !Indexer_ReadMe < prev    next >
Encoding:
Text File  |  1993-05-06  |  6.3 KB  |  186 lines
  1.  
  2.  
  3. DISTRIBUTION DETAILS
  4. /******************/
  5.  
  6. Licence
  7. ~~~~~~~
  8.  
  9.    This application and its contents is (c) Stephen Mansfield 1993. It may be
  10.    distributed freely, provided it is unmodified and distributed in its
  11.    entirety as supplied by the author. The application may not be sold or
  12.    used as part of any commercial product.
  13.  
  14.    Distributed versions of Indexer must have all 11 files included. The
  15.    !Help and ReadMe files must be unaltered.  Thus this software is FREEWARE,
  16.    distribute it, but don't change it!
  17.         
  18.    Current distribution sites include:
  19.        
  20.       1. HENSA server,
  21.       2. Newcastle info-server,
  22.       3. Address at end.
  23.  
  24. Directory Contents
  25. ~~~~~~~~~~~~~~~~~~
  26.  
  27.    Indexer currently has 11 files in its application directory.  All the
  28.    files are needed for Indexer to operate.  All these files are listed
  29.    below along with their primary use, if you find any missing, please
  30.    contact me directly for an unaltered copy of Indexer.
  31.         
  32.    Files distributed:
  33.  
  34.       !Boot        975 bytes  Loads application sprites and sets file type
  35.       !Help       1194 bytes  Indexer manual
  36.       !Run        1457 bytes  Loads and runs application
  37.       !RunImage  35951 bytes  Executable image of program
  38.       !Sprites22  3600 bytes  Filetype and application sprites (hi-res)
  39.       !Sprites23  1536 bytes  Filetype and application sprites (mode 23)
  40.       !Sprites24  2024 bytes  Filetype and application sprites (normal-res)
  41.       ReadMe      6415 bytes  This file...misc info
  42.       Sprites22   2440 bytes  Hi-res program sprites
  43.       Sprites24   1216 bytes  Normal-res program sprites
  44.       Templates   6037 bytes  Window templates for application
  45.  
  46. Author Details
  47. ~~~~~~~~~~~~~~
  48.  
  49.    Author....Stephen Mansfield
  50.    Study.....Software Engineering at The University of Kent
  51.    E-mail....srm2@ukc.ac.uk
  52.    Address...2 Irvine Drive, Margate, Kent, CT9 3XA, England
  53.  
  54.    Please do not hesitate to contact me if you have any suggestions or
  55.    general feedback (including bug reports).
  56.    
  57.  
  58. TECHNICAL INFORMATION
  59. /*******************/
  60.  
  61. Program History
  62. ~~~~~~~~~~~~~~~
  63.  
  64.    Release...0.45
  65.    Date......22th December 1992
  66.    
  67.    Initial release of program into the Internet service using servers at
  68.    Newcastle and HENSA.  This release of the program is not supportted any
  69.    more.
  70.    
  71.    Release...0.51
  72.    Date......27th January 1993
  73.    
  74.    Many features were modified and added, some orignal, and some from
  75.    people who returned feedback, many modifications can be credited to
  76.    these people:
  77.    
  78.       * Window template file loaded at program initialisation
  79.         - Dick Alstein
  80.         - Roger David Clark
  81.       * Disc comment field
  82.         - Colin Smale
  83.       * Updating existing discs in the file, rescanning with confirmation.
  84.         - Colin Smale
  85.       * Object searches more useful, thus default in Find disc dbox.
  86.         - Roger David Clark
  87.       * Object and disc seaches are now case insensitive.
  88.         - Roger David Clark
  89.    
  90.    Other original changes made include:
  91.    
  92.       * Disc scan date field
  93.       * File & directory date stamps.
  94.         - metioned by Colin Smale
  95.       * Directory arrow indicating sub-directory.
  96.       * Confirmation on existing discs when merging files.
  97.       
  98.    Release...0.52
  99.    Date......6th Feburary 1993
  100.     
  101.    A bug which cuased the shared C library to terminate the program has
  102.    been fixed.  It occurred when more than 50 or so discs made up a file. 
  103.    It had existed since release 0.45.
  104.  
  105.    Release...0.60
  106.    Date......4th May 1993
  107.  
  108.    Indexer has had a major over-hall for this release, the modifications are
  109.    listed below.  Still, several things are not completed yet such as a text
  110.    export option and further interactions in searches.
  111.  
  112.    Changes made:
  113.  
  114.       * Window templates changed to use 3D buttons and outline fonts.
  115.       * Menu entries converted to outline font.
  116.       * Prefences environment variable to customise the look of some windows.
  117.       * Paths to scan are user definable in Misc menu, saved with each disc.
  118.       * Fully collapsable/expandable directory tree implemented in disc window.
  119.          * directories can be highlighted/opened/expanded/closed
  120.            use click adjust/double click select/shift-double click select/
  121.            double click adjust
  122.          * menu entries to manipulate tree
  123.       * Main menu implemented for disc window.
  124.          * disc window colours changeable
  125.          * disc window content changeable, ie preferences
  126.       * Internal workings of Indexer modified, re-scanning a disc now involves
  127.         the disc position in the file not changing.
  128.  
  129. File Format
  130. ~~~~~~~~~~~
  131.  
  132.    The following BNF statements detail the file format used by !Indexer for
  133.    its data files.  The file format release is currently 0.60.
  134.    
  135.    File Definition:
  136.  
  137.       indexer_file   ::= <file_signature> <disc_count> { <disc_offset> }
  138.                          { <disc_struct> };
  139.       file_signature ::= UINT;
  140.       disc_count     ::= UINT;
  141.       disc_offset    ::= UNIT;
  142.    
  143.    Disc Definition:
  144.  
  145.       disc_struct  ::= <name> <scan_date> <free> <format> <comment> <path>
  146.                        <object_count> { <object_struct> };
  147.       name         ::= <sting>;
  148.       scan_date    ::= BYTE BYTE BYTE BYTE BYTE;
  149.       free         ::= UINT;
  150.       format       ::= INT;
  151.       comment      ::= <string>;
  152.       path         ::= <string>;
  153.       object_count ::= UINT;
  154.       string       ::= { CHAR } NULL;
  155.  
  156.    Object Definition:
  157.  
  158.       object_struct    ::= <file_object> | <directory_object>;
  159.       file_object      ::= <object_type> <name> <attributes> <level> <stamp>
  160.                            <length> <file_type>;
  161.       directory_object ::= <object_type> <name> <attributes> <level> <stamp>;
  162.       Object_type      ::= BYTE;
  163.       Attribute        ::= BYTE;
  164.       Level            ::= BYTE;
  165.       Length           ::= UINT;
  166.       File_type        ::= BYTE BYTE;
  167.    
  168.    Terminators:
  169.  
  170.       UINT unsigned int
  171.       INT  int
  172.       BYTE unsigned char
  173.       CHAR char
  174.       NULL '\0'
  175.  
  176.    Please note that the strings mentioned above in the file do have a maximum
  177.    length, eg the <comment> field which is limited to 40 characters plus null.
  178.  
  179.    Before file format 0.60, there was 0.51, Indexer reads both these versions
  180.    of its data files but only writes out the newer 0.60 format. The missing
  181.    field in 0.51 is the <path> field, this is reset to '$' when loaded in.
  182.  
  183.  
  184. Stephen Mansfield
  185. (4-May-93)
  186.